Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Light refactoring and code documentation #39

Merged
merged 21 commits into from
Jan 18, 2025

Conversation

endorpersand
Copy link
Contributor

@endorpersand endorpersand commented Jan 9, 2025

Minor refactors and doc comments for components and scripts.

The important refactors of this PR:

  • Encapsulate the timer in caucus pages to TimerPanel component
  • Generally simplify SpeakerList's props
  • Removed a bunch of dnd.ts helpers that only existed because of poor programming

Doc comments:

  • src/lib/context/index.svelte.ts
  • src/lib/flags
  • src/lib/flags/flagcdn.ts
  • src/lib/util
  • src/lib/util/dnd.ts
  • src/lib/util/clock.ts
  • src/lib/util/index.ts
  • src/lib/util/popup.ts (added)
  • src/lib/util/time.ts
  • src/lib/types.d.ts
  • src/lib/motions
  • src/lib/motions/form_validation.ts
  • src/lib/motions/types.d.ts
  • src/lib/motions/sort.ts
  • src/lib/motions/definitions.ts
  • src/lib/components
  • src/lib/components/MetaTags.svelte
  • src/lib/components/SpeakerList.svelte
  • src/lib/components/MotionForm.svelte
  • src/lib/components/IconLabel.svelte
  • src/lib/components/motions
  • src/lib/components/motions/TimerPanel.svelte
  • src/lib/components/motions/page
  • src/lib/components/motions/page/ModCaucus.svelte
  • src/lib/components/motions/page/RoundRobin.svelte
  • src/lib/components/motions/page/UnmodCaucus.svelte
  • src/lib/components/Timer.svelte
  • src/lib/components/modals
  • src/lib/components/modals/EditDelegateCard.svelte
  • src/lib/components/modals/EnableDelegatesCard.svelte
  • src/lib/components/modals/EditMotionCard.svelte
  • src/lib/components/modals/EditModal.svelte
  • src/lib/components/app-bar
  • src/lib/components/app-bar/BarStats.svelte
  • src/lib/components/app-bar/BarHeader.svelte
  • src/lib/components/nav
  • src/lib/components/nav/Navigation.svelte
  • src/lib/components/nav/SettingsNavigation.svelte
  • src/lib/components/del-input (deleted)
  • src/lib/components/del-input/DelAutocomplete.svelte
  • src/lib/components/del-input/DelPopup.svelte (deleted)
  • src/lib/components/LabeledSlideToggle.svelte
  • src/lib/components/del-label
  • src/lib/components/del-label/DelFlag.svelte
  • src/lib/components/del-label/DelLabel.svelte
  • src/lib/db/keyval.ts
  • src/lib/db/delegates.ts
  • src/lib/db/index.svelte.ts
  • src/lib/delegate_presets
  • src/routes/+layout.ts
  • src/routes/+page.svelte
  • src/routes/admin/settings/+page.svelte
  • src/routes/admin/+page.server.ts
  • src/routes/admin/+page.svelte
  • src/routes/admin/+layout.svelte
  • src/routes/admin/stats/+page.svelte
  • src/routes/dashboard/+page.server.ts
  • src/routes/dashboard/+page.svelte
  • src/routes/dashboard/speaker-list/+page.svelte
  • src/routes/dashboard/current-motion/+page.svelte
  • src/routes/dashboard/utilities/+page.svelte
  • src/routes/dashboard/roll-call/+page.svelte
  • src/routes/dashboard/points-motions/+page.svelte
  • src/routes/dashboard/+layout.svelte
  • src/routes/+layout.svelte

@endorpersand endorpersand linked an issue Jan 9, 2025 that may be closed by this pull request
@endorpersand endorpersand marked this pull request as ready for review January 18, 2025 16:36
@endorpersand endorpersand merged commit 79b2e66 into main Jan 18, 2025
@endorpersand endorpersand deleted the light-refactor-and-documentation branch January 18, 2025 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Code Documentation
1 participant